Skip to content

docs: update docs - #82

Merged
omahjoub merged 1 commit into
mainfrom
docs
Aug 30, 2026
Merged

docs: update docs#82
omahjoub merged 1 commit into
mainfrom
docs

Conversation

@omahjoub

Copy link
Copy Markdown
Owner

Summary

Update Docs

Type of change

  • Bug fix
  • New feature / capability
  • New module
  • Refactoring (no behavior change)
  • Breaking change
  • Documentation / tooling / CI only

Test plan

  • mvn verify passes locally
  • Live tests pass against the real Fanar API (if applicable, with FANAR_API_KEY set)
  • GraalVM --self-test passes (if the SDK's reflective surface changed)

Reviewer checklist

  • Public API changes are intentional, documented in javadoc, and an ADR was added/updated if the design changed
  • Which *IntegrationTest proves the behaviour this PR claims? (100 % JaCoCo on a unit is not proof of wiring — see CONTRIBUTING "Testing")
  • Breaking changes carry @Deprecated(since, forRemoval = true) and a migration path in the PR description
  • BOM updated if modules were added or removed
  • No third-party types leak into qa.fanar.core public API
  • If a non-obvious project decision was made, capture it in memory/ so future contributors find it

@omahjoub
omahjoub merged commit 4d4ef92 into main Aug 30, 2026
3 checks passed
@omahjoub
omahjoub deleted the docs branch August 30, 2026 17:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant